Skip to content

Note the metadata convention for generated binaries - #20

Merged
dabeckham merged 1 commit into
mainfrom
docs/generated-file-conventions
Jul 26, 2026
Merged

Note the metadata convention for generated binaries#20
dabeckham merged 1 commit into
mainfrom
docs/generated-file-conventions

Conversation

@dabeckham

@dabeckham dabeckham commented Jul 26, 2026

Copy link
Copy Markdown
Owner

Tool-generated files carry an embedded record of the machine that produced
them. The report PDF under docs/reports, for instance, still names the HTML
file it was rendered from (honest-report.html), the rendering engine and
version (Skia/PDF m149, HeadlessChrome), the operating system
(Windows NT 10.0; Win64; x64), and the minute it was generated. None of it is
visible in the document; all of it is in a public repository.

Nothing sensitive in that particular file, and rewriting a published artifact
over benign metadata is not worth it — so it stays as it is. This just writes
the convention down so the next generated artifact gets stripped before it
lands.

Tool-generated files carry an embedded record of the machine that produced
them. The report PDF under docs/reports, for instance, still names the HTML
file it was rendered from, the browser engine and version, the operating
system, and the minute it was made — none of it visible in the document, all
of it in a public repository.

Nothing sensitive in that particular file, so it stays as it is. Writing the
convention down so the next generated artifact gets stripped before it lands.
@dabeckham
dabeckham merged commit 22da97a into main Jul 26, 2026
2 checks passed
@dabeckham
dabeckham deleted the docs/generated-file-conventions branch July 26, 2026 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant